Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adds instructions for collecting and sending native histograms with otel collector #9328

Merged
merged 16 commits into from
Sep 26, 2024

Conversation

tacole02
Copy link
Contributor

@tacole02 tacole02 commented Sep 18, 2024

What this PR does

This PR updates https://grafana.com/docs/mimir/next/send/native-histograms/ with instructions for collecting and sending native histograms with the OTel Collector.

Which issue(s) this PR fixes or relates to

Fixes https://github.com/grafana/mimir-squad/issues/2131)](https://github.com/grafana/mimir-squad/issues/2131

Checklist

  • Tests updated.
  • Documentation added.
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX].
  • about-versioning.md updated with experimental features.

@tacole02 tacole02 added the type/docs Improvements or additions to documentation label Sep 18, 2024
@tacole02 tacole02 self-assigned this Sep 18, 2024
@tacole02 tacole02 requested a review from a team as a code owner September 18, 2024 19:56
tacole02 and others added 5 commits September 19, 2024 09:15
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
Copy link
Contributor

@krajorama krajorama left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're getting there

krajorama and others added 4 commits September 24, 2024 10:08
Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>

For more information about creating a view, refer to [View](https://opentelemetry.io/docs/specs/otel/metrics/sdk/#view) in the OpenTelemetry Metrics SDK.

1. Modify dashboards to use the exponential histogram metrics. Refer to [Visualize native histograms](https://grafana.com/docs/mimir/<MIMIR_VERSION>/visualize/native-histograms/) for more information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: maybe make common text with the other doc reusable/common in a followup PR if possible so the two docs don't deviate?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can look into this idea for a future PR, especially when this topic goes GA and will have wider readership. We would still need to substitute all of the classic/native details for explicit bucket/exponential, so I'm not sure it would be worth the effort.

Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
@tacole02
Copy link
Contributor Author

@krajorama WDYT? Can we merge? 🚢 🚢

Copy link
Contributor

@krajorama krajorama left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@56quarters 56quarters enabled auto-merge (squash) September 26, 2024 20:05
@56quarters 56quarters merged commit bfca002 into main Sep 26, 2024
33 checks passed
@56quarters 56quarters deleted the docs/ms-2131 branch September 26, 2024 20:07
@grafanabot
Copy link
Contributor

The backport to release-2.13 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-9328-to-release-2.13 origin/release-2.13
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x bfca002e5e26dd45aa25bd7232628e4e8274ca47
# Push it to GitHub
git push --set-upstream origin backport-9328-to-release-2.13
git switch main
# Remove the local backport branch
git branch -D backport-9328-to-release-2.13

Then, create a pull request where the base branch is release-2.13 and the compare/head branch is backport-9328-to-release-2.13.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-2.13 backport-failed type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants